home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / ltas16.exe / LT41 / EXP16LAN.DOC next >
Text File  |  1993-06-14  |  16KB  |  420 lines
  1.     AI-LANBIOS Low-level Driver for the Intel EtherExpress 16(tm) Adapter 
  2.               (EXP16LAN.DOC - Rev 0.1)
  3.        -----------------------------------------------------
  4.              (C) Copyright 1992, 1993 ARTISOFT, Inc.
  5.          Portions Coyright 1992, 1993 Intel Corporation
  6.  
  7. Introduction
  8. ============
  9.  
  10. The EXP16LAN low-level AI-LANBIOS driver for Intel's EtherExpress 16 ethernet
  11. adapter was developed by Intel Corp. in conformance with the specifications 
  12. outlined in the Artisoft AI-LANBIOS Driver Development Program.  The 
  13. low-level driver interfaces directly to the network hardware and
  14. provides basic unreliable data transfer capabilities.  The AI-LANBIOS
  15. high-level driver provides the reliable data transfer capabilities
  16. including all NETBIOS functions.
  17.  
  18. The EXP16LAN driver makes extensive use of the on-board memory of the 
  19. EtherExpress 16 board to improve network throughput.
  20.  
  21. NOTE:   For performance and compatibility reasons, the EXP16LAN driver 
  22.     is an I/O mapped-only version for the EtherExpress 16 adapter.  
  23.     This means that even if you have your adapter configured to run 
  24.     in memory mapped mode, the driver will ignore those settings and 
  25.     run in I/O mapped mode.
  26.  
  27. Compatibility Statement
  28. =======================
  29.  
  30. * Version 2.01 of EXP16LAN is compatible with Artisoft's LANtastic/AI Network
  31.  Operating System v4.1, except for the following functional considerations:
  32.     - Frequent disconnects are encountered when trying to configure 
  33.       multiple adapters on 1 node.
  34.     - Cannot exist on a network with traffic other than Lantastic 4.1
  35.       802.3 type packets.
  36.     - Not compatible with XT systems.
  37.     - Does not support XEROX type packets.
  38.     - Hardware support is limited to EtherExpress 16/16TP ISA adapters
  39.     
  40. * Version 2.03 of EXP16LAN is compatible with Artisoft's LANtastic/AI Network
  41.  Operating System v4.1.  This driver works with all EtherExpress 16/16TP/FlashC
  42.  adapters and removes the functional considerations above.
  43.     - System hangs can occur when trying to configure multiple adapters
  44.       on 1 node.
  45.     - Auto-connect feature can fail to detect attached network cable.
  46.  
  47. * Version 3.00 of EXP16LAN is compatible with Artisoft's LANtastic/AI Network
  48.  Operating System v5.0.  This driver works with all EtherExpress 16/16TP/FlashC
  49.  adapters and has the following functional considerations:
  50.     - System hangs can occur when trying to configure multiple adapters
  51.       on 1 node.
  52.     - Auto-connect feature can fail to detect attached network cable.
  53.  
  54. * Version 3.01 of EXP16LAN is compatible with Artisoft's LANtastic/AI Network
  55.  Operating System v5.0.  This driver works with all EtherExpress 16/16TP/FlashC
  56.  adapters and removes the functional considerations above.  It has a new auto-
  57.  config feature when using multiple adapters on 1 node.
  58.     - Automatically finds next available adapter and assigns a mutiplex
  59.       number if no IOBASE or MPX parameter is specified on command line.
  60.     - Detects an IRQ conflict if more than 1 adapter is configured for
  61.       the same interrupt request.
  62.       
  63. In addition, the EXP16LAN driver does not accept IRQ as a command line switch 
  64. because the settings on the card are controlled by Intel's SOFTSET(tm) program.
  65.  
  66. Vendor Information
  67. ==================
  68.  
  69. Intel Personal Computer Enhancement Division.  5200, N.E. Elam Young Pkwy.
  70. Hillsboro  OR 97124-6497.  Tech Support Phone Number: 503-629-7576.
  71.  
  72. Running EXP16LAN
  73. ================
  74.  
  75. Before running the EXP16LAN driver, configure your EtherExpress board by
  76. running the SOFTSET program that is contained on the driver disk that came
  77. with your EtherExpress board.
  78.  
  79. The EXP16LAN low-level driver must be run before the AI-LANBIOS.  The
  80. EXP16LAN driver interfaces to the AI-LANBIOS using a DOS multiplex (Int 2Fh)
  81. interrupt number.  The default multiplex number is C7.  If you are only
  82. running one low-level driver and one copy of AI-LANBIOS then you will
  83. not have to worry about which multiplex number to assign.  Multiplex
  84. numbers 00 through BF are reserved for DOS use so you must use a multiplex
  85. number between C0 through FF.
  86.  
  87. * Warning: Testing results showed that frequent disconnects were encountered
  88. when trying to configure multiple adapters (and invocations of EXP16LAN.EXE
  89. v2.01) on a single node.  See Compatibility Statement above. *
  90.  
  91. Each invocation of the EXP16LAN driver supports one Intel EtherExpress 16 
  92. adapter board.  You must run multiple copies of EXP16LAN if you have multiple 
  93. cards installed in your computer.  For each invocation of EXP16LAN you must 
  94. run a separate invocation of the AI-LANBIOS program.  When running multiple
  95. invocations of the EXP16LAN driver each invocation must have a unique
  96. multiplex number and I/O base address (V2.01/2.03/3.00).  The multiplex number
  97. and I/O base address can be assigned automatically by not specifying these
  98. parameters on the command line (V3.01).
  99.  
  100. The EXP16LAN low-level driver program name is EXP16LAN.EXE.  The syntax for
  101. EXP16LAN is
  102.  
  103.      EXP16LAN[switches . . . ] [ ; comment]
  104.  
  105. where [switches . . . ] denotes zero or more optional command line switches. 
  106. Switches may be delimited by blanks or slashes (/).  If a switch takes a
  107. value, the switch must be followed by an equal sign (=) or a colon (:).
  108. Some values may be hexadecimal numbers while other values may be decimal.
  109. All switch values are range checked and illegal values produce errors.
  110.  
  111. You may place a comment on the command line by preceding the comment with
  112. a semicolon (;).  You must precede the comment character with a blank.
  113.  
  114. The valid switch formats are:
  115.  
  116.      SWITCH
  117.      SWITCH:value
  118.      /SWITCH
  119.      /SWITCH=value
  120.      @file
  121.  
  122. The valid EXP16LAN switches are enumerated below.  The letters "ddd"
  123. denote a decimal number.  The letters "hh" denote a hexadecimal number. 
  124. Values enclosed in [] indicate default values if the switch is omitted. 
  125. Values after [] denote the valid range of the switch. 
  126.  
  127. ----------
  128.     @switch-file
  129.  
  130. This option specifies that further switches are to be taken from an
  131. switch file.  Any switches after the @switch-file name will be used,
  132. and the switch settings take precedence over any settings in the switch
  133. file.  You may invoke switch files from within switch files as often as
  134. you wish.  The file should contain valid switches and may contain comment
  135. characters (;) at the beginning of each line or after switches.
  136.  
  137. For example,
  138.  
  139.     EXP16LAN @setup
  140.  
  141. The file SETUP contains
  142.  
  143.     ; EXP16LAN AI-LANBIOS driver setup file
  144.  
  145.     IOBASE=310            ; Use I/O address 310
  146.     verbose               ; Display verbose information
  147.  
  148. ----------
  149.     HELP or ?
  150.  
  151. This switch displays information about the valid command line switches,
  152. but does not install the EXP16LAN driver.  For example,
  153.  
  154.     EXP16LAN/help
  155.     EXP16LAN ?
  156.  
  157. See the messages section for a detailed description of the HELP display
  158. output.
  159.  
  160. ----------
  161.     IOBASE=hhhh [300] 200, 210, 220, 230, 240, 250, 260, 270,
  162.               300, 310, 320, 330, 340, 350, 360, 370
  163.  
  164. This switch specifies the I/O base address configured on the EtherExpress
  165. card.  The IOBASE switch value must match the value stored in the board EEPROM.
  166. The default value is the same as the default factory setting on the cards.
  167.  
  168. Unless you have more than one EtherExpress board installed in your computer,
  169. the IOBASE switch is unnecessary, as the driver can find and initialize 
  170. the board - (V2.01/2.03/3.00)
  171.  
  172. The driver can find and initialize 
  173.  
  174. To set the I/O base address on the card, run Intel's SOFTSET program.
  175.  
  176. ----------
  177.     MPX=hh [C7] C0-FF
  178.  
  179. This switch specifies the multiplex (MPX) interrupt number to use for
  180. communication to the high-level AI-LANBIOS.  You will need to change this
  181. value only if the MPX number is in use by another application or low-level
  182. driver.
  183.  
  184. ----------
  185.     PACKET_SIZE=dddd [1500] (574-1500 - V2.01/2.03) (600-1500 - V3.00/3.01)
  186.  
  187. This switch specifies the maximum data size of transmitted packets.
  188. You may need to change this value when using certain bridges that do not
  189. support the full 1500 byte packet size.  Even when you reduce the packet
  190. size, the low-level driver can still receive large packets.
  191.  
  192.  
  193. ----------
  194.     XEROX [XEROX] - V3.00/3.01
  195.  
  196. This switch specifies the XEROX format of the packet header.
  197.  
  198. ----------
  199.     IEEE [IEEE] - V2.01/2.03
  200. This switch specifies the IEEE 802.3 format of the packet header.
  201.  
  202. ----------
  203.     REMOVE
  204.  
  205. This switch removes EXP16LAN.EXE from memory.  You must remove TSR programs
  206. in the opposite order they were loaded.  For example, if you loaded
  207. EXP16LAN.EXE and then AILANBIO, you must remove AILANBIO before EXP16LAN.EXE
  208. In addition, if you have more than one invocation of EXP16LAN.EXE and
  209. AILANBIO you must use the MPX= switch on the command line to specify which
  210. copy of EXP16LAN.EXE but not (AILANBIO) that you want to unload.  For
  211. example, if you load two copies of EXP16LAN.EXE and AILANBIO:
  212.  
  213. EXP16LAN.EXE/MPX=C7
  214. AILANBIO/ADAPTER=0/MPX=C7
  215. EXP16LAN.EXE/MPX=D7
  216. AILANBIO/ADAPTER=1/MPX=D7
  217.  
  218. To unload these copies of EXP16LAN.EXE and AILANBIO:
  219.  
  220. AILANBIO/REMOVE
  221. EXP16LAN.EXE/MPX=D7/REMOVE
  222. AILANBIO/REMOVE
  223. EXP16LAN.EXE/MPX=C7/REMOVE
  224.  
  225. The REMOVE option will remove the most recently run copy of AILANBIO.
  226.  
  227. ----------
  228.     VERBOSE
  229.  
  230. This switch causes the EXP16LAN driver to be installed and detailed
  231. information about the configuration of the EXP16LAN driver to be displayed.
  232. See the messages section for a detailed description of the verbose output.
  233.  
  234.  
  235. EXP16LAN messages
  236. =================
  237.  
  238. The EXP16LAN driver produces two types of messages: Informative and Error. 
  239. All error messages are preceded by the text "ERROR:" and cause the EXP16LAN
  240. driver not to be installed.
  241.  
  242. --------
  243. MESSAGE:
  244. AI-LANBIOS EXP16LAN driver Vn.nn - (C) Copyright 1992 ARTISOFT Inc.
  245.  
  246. This message appears each time the low-level driver is invoked.
  247.  
  248. --------
  249. MESSAGE:
  250.            ---- EXP16LAN driver installed ----
  251.  
  252. This message appears after the low-level driver is successfully
  253. installed. 
  254.  
  255. --------
  256. MESSAGE:
  257.          ---- EXP16LAN driver NOT installed ----
  258.  
  259. This message appears if the low-level driver is not installed.  The driver
  260. will not be installed if help information is displayed or an error
  261. occurred.
  262.  
  263. --------
  264. MESSAGE:
  265.  
  266. Command line             /verbose 
  267. IEEE 802.3 node address  02608C4B10CC   Network packet size      1500 
  268. MPX interface number     C7             Machine bus type         PC/XT/AT     
  269. IO base address          0300           Interrupt request (IRQ)  2
  270. Packet type              IEEE 802.3     
  271. Bytes of memory used     2160
  272.  
  273. This message appears if the VERBOSE switch is specified.  The values
  274. displayed specify how the low-level driver is configured.  Some values may
  275. not agree with switch values you specified on the command line.  This will
  276. happen when you specify an IOBASE or RAMBASE switch value that is not a
  277. proper multiple of the allowed value.
  278.  
  279. --------
  280. MESSAGE:
  281.  
  282. Valid command line switches:
  283.    HELP
  284.    IOBASE= One of the following choices:
  285.       200 210 220 230 240 250 260 270 
  286.       300 310 320 330 340 350 360 370
  287.    MPX= range C0 to FF hex
  288.    PACKET_SIZE= range 570 to 1500 decimal
  289.    VERBOSE
  290.    ?
  291.    @ range 0 to 2048 byte file
  292.  
  293. This message appears when the HELP or ? switch is used.  Each valid switch
  294. is listed with the acceptable range of values (if any) and the base (hex
  295. or decimal) that the numbers must be entered in.  The acceptable file size
  296. range for indirect files (@) is also listed.  The low-level driver is not
  297. installed when this switch is used.
  298.  
  299. --------
  300. MESSAGE:
  301.  
  302.          ---- EXP16LAN removed ----
  303.  
  304. The EXP16LAN.EXE driver has been removed from memory.
  305.  
  306. --------
  307. ERROR:   EXP16LAN not loaded
  308.  
  309. Meaning: You have issued the EXP16LAN/REMOVE command and do not have
  310.      EXP16LAN.EXE loaded into memory.
  311.  
  312. Remedy:  Only issue this command after the program is loaded.
  313.  
  314. --------
  315. ERROR:   Can't REMOVE -- EXP16LAN interrupts re-hooked
  316.  
  317. Meaning: You have attempted to remove EXP16LAN.EXE and the interrupts are
  318.      in use by another TSR, or EXP16LAN.EXE was not the last TSR
  319.      loaded.
  320.  
  321. Remedy:  Remove any TSRs loaded after EXP16LAN.EXE.  For example, if you
  322.      load EXP16LAN.EXE then AILANBIO.EXE, you must first remove
  323.      AILANBIO.EXE, then you can remove EXP16LAN.EXE.
  324.  
  325. --------
  326. ERROR:   Installed EXP16LAN is different version
  327.  
  328. Meaning: You have loaded a version of the EXP16LAN.EXE program and
  329.      attempted to remove it from memory with the /REMOVE switch.  The
  330.      version with which you are attempting to remove EXP16LAN.EXE is
  331.      not the same version that was loaded.
  332.  
  333. Remedy:  Remove EXP16LAN.EXE with the same version of the program that was
  334.      loaded.
  335.  
  336. --------
  337. ERROR:   MPX number hh is already in use - Try another number
  338.  
  339. Meaning: Multiplex (MPX) interrupt number hh is being used by another
  340.      application or low-level driver.
  341.  
  342. Remedy:  Try another MPX number.
  343.  
  344. --------
  345. ERROR:   No network hardware found at I/O base address ????H
  346.  
  347. Meaning: The EtherExpress 16 hardware could not be located.  This error message
  348.      appears displayed because the adapter card is not present or the
  349.      IOBASE specified on the command line is different from what is
  350.      jumpered on the adapter.
  351.  
  352. Remedy:  Check to see that the IOBASE switch specified on the
  353.      EXP16LAN.EXE command line matches the I/O Address setting contained in
  354.     the EtherExpress board's EEPROM.  To do this, run Intel's SOFTSET 
  355.     program and choose the VIEW CURRENT CONFIGURATION menu.
  356.  
  357. --------
  358. ERROR:   Illegal switch - ??????=nnnn
  359.  
  360. Meaning: The switch ??????=nnnn is not a recognized switch.
  361.  
  362. Remedy:  You may only specify legal switches on the command line.
  363.  
  364. --------
  365. ERROR:   Illegal character after switch name - ??????xnnnn
  366.  
  367. Meaning: The switch ?????? is followed by a character other than "=" or
  368.      ":" or the switch does not take a value.
  369.  
  370. Remedy:  Only use the characters "=" or ":" to specify switch values and
  371.      do not place characters after switches that do not take values.
  372.  
  373. --------
  374. ERROR:   Switch value not in range - ??????=nnnn
  375.      Valid range is ssss to eeee
  376.  
  377. Meaning: The value nnnn is not in proper range.  The value ssss
  378.      represents the lowest acceptable value and the value eeee
  379.      represents the highest acceptable value.
  380.  
  381. Remedy:  Limit your range of values to the acceptable range.
  382.  
  383. --------
  384. ERROR:   Illegal digit in switch value - ??????=nnnn
  385.  
  386. Meaning: An illegal digit (character) was encountered in the numeric
  387.      switch value.
  388.  
  389. Remedy:  You must restrict numeric decimal values to the numbers 0-9. 
  390.      You must restrict hexadecimal values to the numbers 0-9 and the
  391.      letters A-F.
  392.  
  393. --------
  394. ERROR:   Cannot open indirect file - @file
  395.  
  396. Meaning: The file "file" cannot be opened as an indirect file.
  397.  
  398. Remedy:  The file must exist before it can be used as an indirect file.
  399.  
  400.  
  401. Testing EXP16LAN return code (error level)
  402. ========================================
  403.  
  404. You may test the EXP16LAN return code or error level in a batch file by
  405. using the IF ERRORLEVEL command.  The following error levels are returned:
  406.  
  407.      0     No error has encountered.  EXP16LAN driver installed
  408.      1     MPX number is in use
  409.      2     Switch error
  410.      3     No memory found or memory error
  411.      4     No hardware found or hardware already in use
  412.      6     EXP16LAN not loaded
  413.      7     Can't remove, different version loaded
  414.      8     Cannot remove, interrupts re-hooked
  415.      9     ERROR: Can't REMOVE -- AI-LANBIOS (R) still installed
  416. -------------------
  417.  
  418.  
  419.  
  420.